<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfcBrowserIter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch04.html" title="Libinfinity client side API">
<link rel="prev" href="InfcBrowser.html" title="InfcBrowser">
<link rel="next" href="libinfinity-0.4-InfcNotePlugin.html" title="InfcNotePlugin">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfcBrowser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="libinfinity-0.4-InfcNotePlugin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinfinity-0.4-InfcBrowserIter.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libinfinity-0.4-InfcBrowserIter.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="InfcBrowserIter">
<a name="libinfinity-0.4-InfcBrowserIter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinfinity-0.4-InfcBrowserIter.top_of_page"></a>InfcBrowserIter</span></h2>
<p>InfcBrowserIter — Iterating through browsed nodes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinfinity-0.4-InfcBrowserIter.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinfinity-0.4-InfcBrowserIter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/client/infc-browser-iter.h&gt;

                    <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter">InfcBrowserIter</a>;
<a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="returnvalue">InfcBrowserIter</span></a> *   <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#infc-browser-iter-copy" title="infc_browser_iter_copy ()">infc_browser_iter_copy</a>              (<em class="parameter"><code><a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> *iter</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#infc-browser-iter-free" title="infc_browser_iter_free ()">infc_browser_iter_free</a>              (<em class="parameter"><code><a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> *iter</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinfinity-0.4-InfcBrowserIter.description"></a><h2>Description</h2>
<p>
The <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> is used to iterate through the nodes of a
<a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>. Normally, <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> is allocated on the stack and
initialized by a <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> API call, such as
<a class="link" href="InfcBrowser.html#infc-browser-iter-get-root" title="infc_browser_iter_get_root ()"><code class="function">infc_browser_iter_get_root()</code></a>. You can also safely copy the struct by
value to create a copy. It is not necessary to free it.
</p>
<p>
Most operations are done via the <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> API. These methods could be
useful to language bindings.
</p>
<p>
An initialized <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> always points to a node within the
<a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>. It stays valid as long as the node it points to is not
removed from the browser (if it is, the <a class="link" href="InfcBrowser.html#InfcBrowser-node-removed" title='The "node-removed" signal'><span class="type">"node-removed"</span></a>) signal
is emitted.
</p>
</div>
<div class="refsect1" title="Details">
<a name="libinfinity-0.4-InfcBrowserIter.details"></a><h2>Details</h2>
<div class="refsect2" title="InfcBrowserIter">
<a name="InfcBrowserIter"></a><h3>InfcBrowserIter</h3>
<pre class="programlisting">typedef struct {
  guint node_id;
  gpointer node;
} InfcBrowserIter;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="infc_browser_iter_copy ()">
<a name="infc-browser-iter-copy"></a><h3>infc_browser_iter_copy ()</h3>
<pre class="programlisting"><a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="returnvalue">InfcBrowserIter</span></a> *   infc_browser_iter_copy              (<em class="parameter"><code><a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> *iter</code></em>);</pre>
<p>
Makes a dynamically allocated copy of <em class="parameter"><code>iter</code></em>. This should not be used by
applications because you can copy the structs by value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A newly-allocated copy of <em class="parameter"><code>iter</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="infc_browser_iter_free ()">
<a name="infc-browser-iter-free"></a><h3>infc_browser_iter_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                infc_browser_iter_free              (<em class="parameter"><code><a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> *iter</code></em>);</pre>
<p>
Frees a <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a> allocated by <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#infc-browser-iter-copy" title="infc_browser_iter_copy ()"><code class="function">infc_browser_iter_copy()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a class="link" href="libinfinity-0.4-InfcBrowserIter.html#InfcBrowserIter" title="InfcBrowserIter"><span class="type">InfcBrowserIter</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="libinfinity-0.4-InfcBrowserIter.see-also"></a><h2>See Also</h2>
<a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>